MarkLogic 9 Product Documentation

GET /manage/v2/groups/{id|name}/properties

Summary

This resource address returns the configuration properties of the named group in the cluster.

Response

Upon success, MarkLogic Server returns status code 200 (OK). The response body contains the requested data. If the payload is malformed, a status code of 400 (Bad Request)is returned. A status code of 401 (Unauthorized) is returned if the user does not have the necessary privileges.

Required Privileges

http://marklogic.com/xdmp/privileges/manage-admin

Usage Notes

The name name is reserved.

The value of the group-id property is not returned, its converted value is returned in the "name" property.

The values of the meters-database and security-database properties are converted into names.

The task server and scheduled properties will be addressed through a separate endpoint.

Response will be valid according to the schema type group-properties in the manage-group-properties.xsd schema. JSON payloads are internally converted to XML before validation.

group-name

The name of a group of servers.

cache-sizing

The cache sizing method.

list-cache-size

The size of the list cache, in megabytes.

list-cache-partitions

The number of list cache partitions.

compressed-tree-cache-size

The size of the compressed tree cache, in megabytes.

compressed-tree-cache-partitions

The number of compressed tree cache partitions.

expanded-tree-cache-size

The size of the expanded tree cache, in megabytes.

expanded-tree-cache-partitions

The number of expanded tree cache partitions.

triple-cache-size

The size of the triple cache, in megabytes.

triple-cache-partitions

The number of triple cache partitions.

triple-value-cache-size

The size of the triple value cache, in megabytes.

triple-value-cache-partitions

The number of triple value cache partitions.

compressed-tree-read-size

The block size for random-access compressed tree file reads, in kilobytes.

triple-cache-timeout

The number of seconds of inactivity before triple index pages are eligible to be flushed from the cache.

triple-value-cache-timeout

The number of seconds of inactivity before triple value index pages are eligible to be flushed from the cache.

smtp-relay

The network location of the SMTP mail relay host.

smtp-timeout

The SMTP response timeout, in seconds.

http-user-agent

The HTTP User-agent string used when making HTTP requests.

http-timeout

The HTTP response timeout, in seconds.

xdqp-timeout

The XDQP protocol timeout, in seconds.

host-timeout

The host response timeout, in seconds.

host-initial-timeout

The host initial response timeout, in seconds.

retry-timeout

The request retry timeout, in seconds.

module-cache-timeout

Flush from caches modules unused after this many seconds.

system-log-level

The minimum log level for log messages sent to the operating system.

file-log-level

The minimum log level for log messages in the log file.

rotate-log-files

When to start a new log file.

keep-log-files

How many log files to keep.

failover-enable

Enable forest assignment to a failover host when the primary host is down.

xdqp-ssl-enabled

Whether or not SSL is enabled for XDQP.

xdqp-ssl-allow-sslv3

Whether or not SSLv3 is allowed for XDQP.

xdqp-ssl-allow-tls

Whether or not TLS is allowed for XDQP.

xdqp-ssl-disable-sslv3

Whether or not ssl v3 is disable.

xdqp-ssl-disable-tlsv1

Whether or not TLS v1.0 is disable.

xdqp-ssl-disable-tlsv1-1

Whether or not TLS v1.1 is disable.

xdqp-ssl-disable-tlsv1-2

Whether or not TLS v1.2 is disable.

xdqp-ssl-ciphers

A colon separated list of ciphers (e.g. ALL:!LOW:@STRENGTH)

schemas

The schema binding specifications.

This is a complex structure with the following children:

schema

A schema binding specification.

This is a complex structure with the following children:

namespace-uri

A namespace URI.

schema-location

A schema location.

namespaces

The namespace binding specifications.

This is a complex structure with the following children:

namespace

A namespace binding specification.

This is a complex structure with the following children:

prefix

A QName prefix.

namespace-uri

A namespace URI.

using-namespaces

The default namespace bindings.

This is a complex structure with the following children:

using-namespace

A namespace path URI.

This is a complex structure with the following children:

namespace-uri

A namespace URI.

module-locations

The module location specifications.

This is a complex structure with the following children:

module-location

A module location specification.

This is a complex structure with the following children:

namespace-uri

A namespace URI.

location

A module location.

events-activated

Activates the trace event mechanism.

events

The list of events to enable.

This is a complex structure with the following children:

event

The event specification.

audit

Audit specification.

This is a complex structure with the following children:

audit-enabled

Enables auditing.

rotate-audit-files

When to start a new audit log file.

keep-audit-files

How many audit files to keep.

audit-events

The list of audit events to enable.

This is a complex structure with the following children:

audit-event

The audit event specification.

This is a complex structure with the following children:

audit-event-name

The string identifier of the audit event.

audit-event-enabled

Enables a specified audit event.

audit-restrictions

The list of audit restrictions.

This is a complex structure with the following children:

audit-restriction

The audit restriction specification.

This is a complex structure with the following children:

audit-restriction-name

The string identifier of the audit restriction.

audit-restriction-type

The string identifier of the audit restriction.

audit-restriction-items

The string identifier of the audit restriction.

background-io-limit

The maximum I/O rate allowable for background operations (merge, backup, restore).

metering-enabled

Enable Usage metering.

performance-metering-enabled

Enable performance monitoring history.

meters-database

The metering and performance history database.

performance-metering-period

Historic performance metering period (seconds).

performance-metering-retain-raw

Retain raw performance metering data in days.

performance-metering-retain-hourly

Retain hourly performance metering data in days.

performance-metering-retain-daily

Retain daily performance metering data in days.

telemetry-log-level

The minimum log level for log messages collected by telemetry. A value of 'disabled' disables all telemetry use of log data.

telemetry-metering

The type of metering data collected by telemetry.

telemetry-config

The type of configuration data collected by telemetry.

telemetry-session-endpoint

The REST URI for the Telemetry Session API endpoint.

telemetry-proxy

The URL of the local telemetry proxy.

s3-domain

The simple storage service internet domain name.

s3-protocol

The simple storage service network protocol.

s3-server-side-encryption

Specifies server side encryption for data at rest on the simple storage service.

s3-server-side-encryption-kms-key

Specifies the AWS KMS key ID for server side encryption.

s3-proxy

The URL of the proxy server to access S3.

azure-storage-proxy

The URL of the proxy server to access Azure Blob Storage.

security-database

The security database where global security data are kept for hosts in this group.

Example

curl -X GET  --anyauth -u admin:admin --header "Content-Type:application/json" \
http://localhost:8002/manage/v2/groups/Foo/properties

==>  Returns the properties of the "Foo" group in the cluster.